Download OpenAPI specification:Download
Allows customers to easily access the Okta API
Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.
| q | string |
| after | string Specifies the pagination cursor for the next page of apps |
| limit | integer <int32> Default: -1 Specifies the number of results for a page |
| filter | string Filters apps by status, user.id, group.id or credentials.signing.kid expression |
| expand | string Traverses users link relationship and optionally embeds Application User resource |
| includeNonDeleted | boolean Default: false |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "accessibility": {
- "errorRedirectUrl": "string",
- "loginRedirectUrl": "string",
- "selfService": true
}, - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "signing": {
- "kid": "string",
- "lastRotated": "2019-08-24T14:15:22Z",
- "nextRotation": "2019-08-24T14:15:22Z",
- "rotationMode": "string",
- "use": "sig"
}, - "userNameTemplate": {
- "suffix": "string",
- "template": "string",
- "type": "string"
}
}, - "features": [
- "string"
], - "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "licensing": {
- "seatCount": 0
}, - "name": "string",
- "profile": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "app": null,
- "implicitAssignment": true,
- "inlineHookId": "string",
- "notifications": {
- "vpn": {
- "helpUrl": "string",
- "message": "string",
- "network": {
- "connection": "string",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}
}, - "signOnMode": "BOOKMARK",
- "status": "ACTIVE",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoSubmitToolbar": true,
- "hide": {
- "iOS": true,
- "web": true
}
}
}
]Adds a new application to your Okta organization.
| activate | boolean Default: true Executes activation lifecycle operation when creating the app |
| OktaAccessGateway-Agent | string |
object (ApplicationAccessibility) | |
object (ApplicationCredentials) | |
| features | Array of strings |
| label | string |
object (ApplicationLicensing) | |
object | |
object (ApplicationSettings) | |
| signOnMode | string (ApplicationSignOnMode) Enum: "BOOKMARK" "BASIC_AUTH" "BROWSER_PLUGIN" "SECURE_PASSWORD_STORE" "AUTO_LOGIN" "WS_FEDERATION" "SAML_2_0" "OPENID_CONNECT" "SAML_1_1" |
object (ApplicationVisibility) |
{- "accessibility": {
- "errorRedirectUrl": "string",
- "loginRedirectUrl": "string",
- "selfService": true
}, - "credentials": {
- "signing": {
- "kid": "string",
- "rotationMode": "string",
- "use": "sig"
}, - "userNameTemplate": {
- "suffix": "string",
- "template": "string",
- "type": "string"
}
}, - "features": [
- "string"
], - "label": "string",
- "licensing": {
- "seatCount": 0
}, - "profile": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "app": null,
- "implicitAssignment": true,
- "inlineHookId": "string",
- "notifications": {
- "vpn": {
- "helpUrl": "string",
- "message": "string",
- "network": {
- "connection": "string",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}
}, - "signOnMode": "BOOKMARK",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoSubmitToolbar": true,
- "hide": {
- "iOS": true,
- "web": true
}
}
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "accessibility": {
- "errorRedirectUrl": "string",
- "loginRedirectUrl": "string",
- "selfService": true
}, - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "signing": {
- "kid": "string",
- "lastRotated": "2019-08-24T14:15:22Z",
- "nextRotation": "2019-08-24T14:15:22Z",
- "rotationMode": "string",
- "use": "sig"
}, - "userNameTemplate": {
- "suffix": "string",
- "template": "string",
- "type": "string"
}
}, - "features": [
- "string"
], - "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "licensing": {
- "seatCount": 0
}, - "name": "string",
- "profile": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "app": null,
- "implicitAssignment": true,
- "inlineHookId": "string",
- "notifications": {
- "vpn": {
- "helpUrl": "string",
- "message": "string",
- "network": {
- "connection": "string",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}
}, - "signOnMode": "BOOKMARK",
- "status": "ACTIVE",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoSubmitToolbar": true,
- "hide": {
- "iOS": true,
- "web": true
}
}
}Fetches an application from your Okta organization by id.
| appId required | string |
| expand | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "accessibility": {
- "errorRedirectUrl": "string",
- "loginRedirectUrl": "string",
- "selfService": true
}, - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "signing": {
- "kid": "string",
- "lastRotated": "2019-08-24T14:15:22Z",
- "nextRotation": "2019-08-24T14:15:22Z",
- "rotationMode": "string",
- "use": "sig"
}, - "userNameTemplate": {
- "suffix": "string",
- "template": "string",
- "type": "string"
}
}, - "features": [
- "string"
], - "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "licensing": {
- "seatCount": 0
}, - "name": "string",
- "profile": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "app": null,
- "implicitAssignment": true,
- "inlineHookId": "string",
- "notifications": {
- "vpn": {
- "helpUrl": "string",
- "message": "string",
- "network": {
- "connection": "string",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}
}, - "signOnMode": "BOOKMARK",
- "status": "ACTIVE",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoSubmitToolbar": true,
- "hide": {
- "iOS": true,
- "web": true
}
}
}Updates an application in your organization.
| appId required | string |
object (ApplicationAccessibility) | |
object (ApplicationCredentials) | |
| features | Array of strings |
| label | string |
object (ApplicationLicensing) | |
object | |
object (ApplicationSettings) | |
| signOnMode | string (ApplicationSignOnMode) Enum: "BOOKMARK" "BASIC_AUTH" "BROWSER_PLUGIN" "SECURE_PASSWORD_STORE" "AUTO_LOGIN" "WS_FEDERATION" "SAML_2_0" "OPENID_CONNECT" "SAML_1_1" |
object (ApplicationVisibility) |
{- "accessibility": {
- "errorRedirectUrl": "string",
- "loginRedirectUrl": "string",
- "selfService": true
}, - "credentials": {
- "signing": {
- "kid": "string",
- "rotationMode": "string",
- "use": "sig"
}, - "userNameTemplate": {
- "suffix": "string",
- "template": "string",
- "type": "string"
}
}, - "features": [
- "string"
], - "label": "string",
- "licensing": {
- "seatCount": 0
}, - "profile": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "app": null,
- "implicitAssignment": true,
- "inlineHookId": "string",
- "notifications": {
- "vpn": {
- "helpUrl": "string",
- "message": "string",
- "network": {
- "connection": "string",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}
}, - "signOnMode": "BOOKMARK",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoSubmitToolbar": true,
- "hide": {
- "iOS": true,
- "web": true
}
}
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "accessibility": {
- "errorRedirectUrl": "string",
- "loginRedirectUrl": "string",
- "selfService": true
}, - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "signing": {
- "kid": "string",
- "lastRotated": "2019-08-24T14:15:22Z",
- "nextRotation": "2019-08-24T14:15:22Z",
- "rotationMode": "string",
- "use": "sig"
}, - "userNameTemplate": {
- "suffix": "string",
- "template": "string",
- "type": "string"
}
}, - "features": [
- "string"
], - "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "licensing": {
- "seatCount": 0
}, - "name": "string",
- "profile": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "app": null,
- "implicitAssignment": true,
- "inlineHookId": "string",
- "notifications": {
- "vpn": {
- "helpUrl": "string",
- "message": "string",
- "network": {
- "connection": "string",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}
}, - "signOnMode": "BOOKMARK",
- "status": "ACTIVE",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoSubmitToolbar": true,
- "hide": {
- "iOS": true,
- "web": true
}
}
}Enumerates Certificate Signing Requests for an application
| appId required | string |
[- {
- "created": "2019-08-24T14:15:22Z",
- "csr": "string",
- "id": "string",
- "kty": "string"
}
]Generates a new key pair and returns the Certificate Signing Request for it.
| appId required | string |
object (CsrMetadataSubject) | |
object (CsrMetadataSubjectAltNames) |
{- "subject": {
- "commonName": "string",
- "countryName": "string",
- "localityName": "string",
- "organizationName": "string",
- "organizationalUnitName": "string",
- "stateOrProvinceName": "string"
}, - "subjectAltNames": {
- "dnsNames": [
- "string"
]
}
}{- "created": "2019-08-24T14:15:22Z",
- "csr": "string",
- "id": "string",
- "kty": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Enumerates key credentials for an application
| appId required | string |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}
]Generates a new X.509 certificate for an application key credential
| appId required | string |
| validityYears | integer |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Gets a specific application key credential by kid
| appId required | string |
| keyId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Clones a X.509 certificate for an application key credential from a source application to target application.
| appId required | string |
| keyId required | string |
| targetAid required | string Unique key of the target Application |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Lists all scope consent grants for the application
| appId required | string |
| expand | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopeId": "string",
- "source": "END_USER",
- "status": "ACTIVE",
- "userId": "string"
}
]Grants consent for the application to request an OAuth 2.0 Okta scope
| appId required | string |
| clientId | string |
object (OAuth2Actor) | |
| issuer | string |
| scopeId | string |
| source | string (OAuth2ScopeConsentGrantSource) Enum: "END_USER" "ADMIN" |
| status | string (OAuth2ScopeConsentGrantStatus) Enum: "ACTIVE" "REVOKED" |
| userId | string |
{- "clientId": "string",
- "createdBy": {
- "type": "string"
}, - "issuer": "string",
- "scopeId": "string",
- "source": "END_USER",
- "status": "ACTIVE",
- "userId": "string"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopeId": "string",
- "source": "END_USER",
- "status": "ACTIVE",
- "userId": "string"
}Fetches a single scope consent grant for the application
| appId required | string |
| grantId required | string |
| expand | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopeId": "string",
- "source": "END_USER",
- "status": "ACTIVE",
- "userId": "string"
}Enumerates group assignments for an application.
| appId required | string |
| q | string |
| after | string Specifies the pagination cursor for the next page of assignments |
| limit | integer <int32> Default: -1 Specifies the number of results for a page |
| expand | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "priority": 0,
- "profile": {
- "property1": { },
- "property2": { }
}
}
]Fetches an application group assignment
| appId required | string |
| groupId required | string |
| expand | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "priority": 0,
- "profile": {
- "property1": { },
- "property2": { }
}
}Assigns a group to an application
| appId required | string |
| groupId required | string |
| priority | integer |
object |
{- "priority": 0,
- "profile": {
- "property1": { },
- "property2": { }
}
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "priority": 0,
- "profile": {
- "property1": { },
- "property2": { }
}
}Lists all tokens for the application
| appId required | string |
| expand | string |
| after | string |
| limit | integer <int32> Default: 20 |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopes": [
- "string"
], - "status": "ACTIVE",
- "userId": "string"
}
]Gets a token for the specified application
| appId required | string |
| tokenId required | string |
| expand | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopes": [
- "string"
], - "status": "ACTIVE",
- "userId": "string"
}Enumerates all assigned application users for an application.
| appId required | string |
| q | string |
| query_scope | string |
| after | string specifies the pagination cursor for the next page of assignments |
| limit | integer <int32> Default: -1 specifies the number of results for a page |
| filter | string |
| expand | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "value": "pa$$word"
}, - "userName": "string"
}, - "externalId": "string",
- "id": "string",
- "lastSync": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "string",
- "status": "string",
- "statusChanged": "2019-08-24T14:15:22Z",
- "syncState": "string"
}
]Assigns an user to an application with credentials and an app-specific profile. Profile mappings defined for the application are first applied before applying any profile properties specified in the request.
| appId required | string |
object (AppUserCredentials) | |
| id | string |
object | |
| scope | string |
{- "credentials": {
- "password": {
- "value": "pa$$word"
}, - "userName": "string"
}, - "id": "string",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "string"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "value": "pa$$word"
}, - "userName": "string"
}, - "externalId": "string",
- "id": "string",
- "lastSync": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "string",
- "status": "string",
- "statusChanged": "2019-08-24T14:15:22Z",
- "syncState": "string"
}Fetches a specific user assignment for application by id.
| appId required | string |
| userId required | string |
| expand | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "value": "pa$$word"
}, - "userName": "string"
}, - "externalId": "string",
- "id": "string",
- "lastSync": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "string",
- "status": "string",
- "statusChanged": "2019-08-24T14:15:22Z",
- "syncState": "string"
}Updates a user's profile for an application
| appId required | string |
| userId required | string |
object (AppUserCredentials) | |
| id | string |
object | |
| scope | string |
{- "credentials": {
- "password": {
- "value": "pa$$word"
}, - "userName": "string"
}, - "id": "string",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "string"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "value": "pa$$word"
}, - "userName": "string"
}, - "externalId": "string",
- "id": "string",
- "lastSync": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "string",
- "status": "string",
- "statusChanged": "2019-08-24T14:15:22Z",
- "syncState": "string"
}Success
| q | string |
| limit | string |
| after | string |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "audiences": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "signing": {
- "kid": "string",
- "lastRotated": "2019-08-24T14:15:22Z",
- "nextRotation": "2019-08-24T14:15:22Z",
- "rotationMode": "AUTO",
- "use": "sig"
}
}, - "description": "string",
- "id": "string",
- "issuer": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE"
}
]Success
| audiences | Array of strings |
object (AuthorizationServerCredentials) | |
| description | string |
| issuer | string |
| issuerMode | string Enum: "ORG_URL" "CUSTOM_URL" |
| name | string |
| status | string Enum: "ACTIVE" "INACTIVE" |
{- "audiences": [
- "string"
], - "credentials": {
- "signing": {
- "kid": "string",
- "rotationMode": "AUTO",
- "use": "sig"
}
}, - "description": "string",
- "issuer": "string",
- "issuerMode": "ORG_URL",
- "name": "string",
- "status": "ACTIVE"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "audiences": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "signing": {
- "kid": "string",
- "lastRotated": "2019-08-24T14:15:22Z",
- "nextRotation": "2019-08-24T14:15:22Z",
- "rotationMode": "AUTO",
- "use": "sig"
}
}, - "description": "string",
- "id": "string",
- "issuer": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE"
}Success
| authServerId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "audiences": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "signing": {
- "kid": "string",
- "lastRotated": "2019-08-24T14:15:22Z",
- "nextRotation": "2019-08-24T14:15:22Z",
- "rotationMode": "AUTO",
- "use": "sig"
}
}, - "description": "string",
- "id": "string",
- "issuer": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE"
}Success
| authServerId required | string |
| audiences | Array of strings |
object (AuthorizationServerCredentials) | |
| description | string |
| issuer | string |
| issuerMode | string Enum: "ORG_URL" "CUSTOM_URL" |
| name | string |
| status | string Enum: "ACTIVE" "INACTIVE" |
{- "audiences": [
- "string"
], - "credentials": {
- "signing": {
- "kid": "string",
- "rotationMode": "AUTO",
- "use": "sig"
}
}, - "description": "string",
- "issuer": "string",
- "issuerMode": "ORG_URL",
- "name": "string",
- "status": "ACTIVE"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "audiences": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "signing": {
- "kid": "string",
- "lastRotated": "2019-08-24T14:15:22Z",
- "nextRotation": "2019-08-24T14:15:22Z",
- "rotationMode": "AUTO",
- "use": "sig"
}
}, - "description": "string",
- "id": "string",
- "issuer": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE"
}[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "alwaysIncludeInToken": true,
- "claimType": "IDENTITY",
- "conditions": {
- "scopes": [
- "string"
]
}, - "group_filter_type": "STARTS_WITH",
- "id": "string",
- "name": "string",
- "status": "ACTIVE",
- "system": true,
- "value": "string",
- "valueType": "EXPRESSION"
}
]Success
| authServerId required | string |
| alwaysIncludeInToken | boolean |
| claimType | string Enum: "IDENTITY" "RESOURCE" |
object (OAuth2ClaimConditions) | |
| group_filter_type | string Enum: "STARTS_WITH" "EQUALS" "CONTAINS" "REGEX" |
| name | string |
| status | string Enum: "ACTIVE" "INACTIVE" |
| system | boolean |
| value | string |
| valueType | string Enum: "EXPRESSION" "GROUPS" "SYSTEM" |
{- "alwaysIncludeInToken": true,
- "claimType": "IDENTITY",
- "conditions": {
- "scopes": [
- "string"
]
}, - "group_filter_type": "STARTS_WITH",
- "name": "string",
- "status": "ACTIVE",
- "system": true,
- "value": "string",
- "valueType": "EXPRESSION"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "alwaysIncludeInToken": true,
- "claimType": "IDENTITY",
- "conditions": {
- "scopes": [
- "string"
]
}, - "group_filter_type": "STARTS_WITH",
- "id": "string",
- "name": "string",
- "status": "ACTIVE",
- "system": true,
- "value": "string",
- "valueType": "EXPRESSION"
}Success
| authServerId required | string |
| claimId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "alwaysIncludeInToken": true,
- "claimType": "IDENTITY",
- "conditions": {
- "scopes": [
- "string"
]
}, - "group_filter_type": "STARTS_WITH",
- "id": "string",
- "name": "string",
- "status": "ACTIVE",
- "system": true,
- "value": "string",
- "valueType": "EXPRESSION"
}Success
| authServerId required | string |
| claimId required | string |
| alwaysIncludeInToken | boolean |
| claimType | string Enum: "IDENTITY" "RESOURCE" |
object (OAuth2ClaimConditions) | |
| group_filter_type | string Enum: "STARTS_WITH" "EQUALS" "CONTAINS" "REGEX" |
| name | string |
| status | string Enum: "ACTIVE" "INACTIVE" |
| system | boolean |
| value | string |
| valueType | string Enum: "EXPRESSION" "GROUPS" "SYSTEM" |
{- "alwaysIncludeInToken": true,
- "claimType": "IDENTITY",
- "conditions": {
- "scopes": [
- "string"
]
}, - "group_filter_type": "STARTS_WITH",
- "name": "string",
- "status": "ACTIVE",
- "system": true,
- "value": "string",
- "valueType": "EXPRESSION"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "alwaysIncludeInToken": true,
- "claimType": "IDENTITY",
- "conditions": {
- "scopes": [
- "string"
]
}, - "group_filter_type": "STARTS_WITH",
- "id": "string",
- "name": "string",
- "status": "ACTIVE",
- "system": true,
- "value": "string",
- "valueType": "EXPRESSION"
}Success
| authServerId required | string |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "client_id": "string",
- "client_name": "string",
- "client_uri": "string",
- "logo_uri": "string"
}
]Success
| authServerId required | string |
| clientId required | string |
| expand | string |
| after | string |
| limit | integer <int32> Default: -1 |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopes": [
- "string"
], - "status": "ACTIVE",
- "userId": "string"
}
]Success
| authServerId required | string |
| clientId required | string |
| tokenId required | string |
| expand | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopes": [
- "string"
], - "status": "ACTIVE",
- "userId": "string"
}Success
| authServerId required | string |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}
]Success
| authServerId required | string |
| use | string Value: "sig" |
{- "use": "sig"
}[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}
]Success
| authServerId required | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}
]Success
| authServerId required | string |
object (PolicyRuleConditions) | |
| description | string |
| name | string |
| priority | integer |
| status | string Enum: "ACTIVE" "INACTIVE" |
| system | boolean |
| type | string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY" |
{- "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "description": "string",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}Success
| authServerId required | string |
| policyId required | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}Success
| authServerId required | string |
| policyId required | string |
object (PolicyRuleConditions) | |
| description | string |
| name | string |
| priority | integer |
| status | string Enum: "ACTIVE" "INACTIVE" |
| system | boolean |
| type | string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY" |
{- "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "description": "string",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}Enumerates all policy rules for the specified Custom Authorization Server and Policy.
| policyId required | string |
| authServerId required | string |
[- {
- "actions": {
- "token": {
- "accessTokenLifetimeMinutes": 0,
- "refreshTokenLifetimeMinutes": 0,
- "refreshTokenWindowMinutes": 0
}
}, - "conditions": {
- "clients": {
- "include": [
- "string"
]
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "scopes": {
- "include": [
- "string"
]
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "RESOURCE_ACCESS"
}
]Creates a policy rule for the specified Custom Authorization Server and Policy.
| policyId required | string |
| authServerId required | string |
object (AuthorizationServerPolicyRuleActions) | |
object (AuthorizationServerPolicyRuleConditions) | |
| name | string |
| priority | integer |
| status | string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE" |
| system | boolean Default: false |
| type | string Value: "RESOURCE_ACCESS" |
{- "actions": {
- "token": {
- "accessTokenLifetimeMinutes": 0,
- "refreshTokenLifetimeMinutes": 0,
- "refreshTokenWindowMinutes": 0
}
}, - "conditions": {
- "clients": {
- "include": [
- "string"
]
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "scopes": {
- "include": [
- "string"
]
}
}, - "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "RESOURCE_ACCESS"
}{- "actions": {
- "token": {
- "accessTokenLifetimeMinutes": 0,
- "refreshTokenLifetimeMinutes": 0,
- "refreshTokenWindowMinutes": 0
}
}, - "conditions": {
- "clients": {
- "include": [
- "string"
]
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "scopes": {
- "include": [
- "string"
]
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "RESOURCE_ACCESS"
}Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.
| policyId required | string |
| authServerId required | string |
| ruleId required | string |
{- "actions": {
- "token": {
- "accessTokenLifetimeMinutes": 0,
- "refreshTokenLifetimeMinutes": 0,
- "refreshTokenWindowMinutes": 0
}
}, - "conditions": {
- "clients": {
- "include": [
- "string"
]
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "scopes": {
- "include": [
- "string"
]
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "RESOURCE_ACCESS"
}Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.
| policyId required | string |
| authServerId required | string |
| ruleId required | string |
object (AuthorizationServerPolicyRuleActions) | |
object (AuthorizationServerPolicyRuleConditions) | |
| name | string |
| priority | integer |
| status | string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE" |
| system | boolean Default: false |
| type | string Value: "RESOURCE_ACCESS" |
{- "actions": {
- "token": {
- "accessTokenLifetimeMinutes": 0,
- "refreshTokenLifetimeMinutes": 0,
- "refreshTokenWindowMinutes": 0
}
}, - "conditions": {
- "clients": {
- "include": [
- "string"
]
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "scopes": {
- "include": [
- "string"
]
}
}, - "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "RESOURCE_ACCESS"
}{- "actions": {
- "token": {
- "accessTokenLifetimeMinutes": 0,
- "refreshTokenLifetimeMinutes": 0,
- "refreshTokenWindowMinutes": 0
}
}, - "conditions": {
- "clients": {
- "include": [
- "string"
]
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "scopes": {
- "include": [
- "string"
]
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "RESOURCE_ACCESS"
}Success
| authServerId required | string |
| q | string |
| filter | string |
| cursor | string |
| limit | integer <int32> Default: -1 |
[- {
- "consent": "REQUIRED",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "metadataPublish": "ALL_CLIENTS",
- "name": "string",
- "system": true
}
]Success
| authServerId required | string |
| consent | string Enum: "REQUIRED" "IMPLICIT" "ADMIN" |
| default | boolean |
| description | string |
| displayName | string |
| metadataPublish | string Enum: "ALL_CLIENTS" "NO_CLIENTS" |
| name | string |
| system | boolean |
{- "consent": "REQUIRED",
- "default": true,
- "description": "string",
- "displayName": "string",
- "metadataPublish": "ALL_CLIENTS",
- "name": "string",
- "system": true
}{- "consent": "REQUIRED",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "metadataPublish": "ALL_CLIENTS",
- "name": "string",
- "system": true
}Success
| authServerId required | string |
| scopeId required | string |
{- "consent": "REQUIRED",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "metadataPublish": "ALL_CLIENTS",
- "name": "string",
- "system": true
}Success
| authServerId required | string |
| scopeId required | string |
| consent | string Enum: "REQUIRED" "IMPLICIT" "ADMIN" |
| default | boolean |
| description | string |
| displayName | string |
| metadataPublish | string Enum: "ALL_CLIENTS" "NO_CLIENTS" |
| name | string |
| system | boolean |
{- "consent": "REQUIRED",
- "default": true,
- "description": "string",
- "displayName": "string",
- "metadataPublish": "ALL_CLIENTS",
- "name": "string",
- "system": true
}{- "consent": "REQUIRED",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "metadataPublish": "ALL_CLIENTS",
- "name": "string",
- "system": true
}[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}
]Success
object (EventHookChannel) | |
| createdBy | string |
object (EventSubscriptions) | |
| name | string |
| status | string Enum: "ACTIVE" "INACTIVE" |
| verificationStatus | string Enum: "UNVERIFIED" "VERIFIED" |
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}Success
| eventHookId required | string |
object (EventHookChannel) | |
| createdBy | string |
object (EventSubscriptions) | |
| name | string |
| status | string Enum: "ACTIVE" "INACTIVE" |
| verificationStatus | string Enum: "UNVERIFIED" "VERIFIED" |
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "description": "string",
- "id": "string",
- "name": "string",
- "stage": {
- "state": "OPEN",
- "value": "EA"
}, - "status": "ENABLED",
- "type": "self-service"
}
]{- "_links": {
- "property1": { },
- "property2": { }
}, - "description": "string",
- "id": "string",
- "name": "string",
- "stage": {
- "state": "OPEN",
- "value": "EA"
}, - "status": "ENABLED",
- "type": "self-service"
}[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "description": "string",
- "id": "string",
- "name": "string",
- "stage": {
- "state": "OPEN",
- "value": "EA"
}, - "status": "ENABLED",
- "type": "self-service"
}
][- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "description": "string",
- "id": "string",
- "name": "string",
- "stage": {
- "state": "OPEN",
- "value": "EA"
}, - "status": "ENABLED",
- "type": "self-service"
}
]Success
| featureId required | string |
| lifecycle required | string |
| mode | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "description": "string",
- "id": "string",
- "name": "string",
- "stage": {
- "state": "OPEN",
- "value": "EA"
}, - "status": "ENABLED",
- "type": "self-service"
}Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.
| q | string Searches the name property of groups for matching value |
| filter | string Filter expression for groups |
| after | string Specifies the pagination cursor for the next page of groups |
| limit | integer <int32> Default: 10000 Specifies the number of group results in a page |
| expand | string If specified, it causes additional metadata to be included in the response. |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "OKTA_GROUP"
}
]Adds a new group with OKTA_GROUP type to your organization.
object (GroupProfile) | |
| type | string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN" |
{- "profile": {
- "description": "string",
- "name": "string"
}, - "type": "OKTA_GROUP"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "OKTA_GROUP"
}Lists all group rules for your organization.
| limit | integer <int32> Default: 50 Specifies the number of rule results in a page |
| after | string Specifies the pagination cursor for the next page of rules |
| search | string Specifies the keyword to search fules for |
| expand | string If specified as |
[- {
- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "string"
}
]Creates a group rule to dynamically add users to the specified group if they match the condition
object (GroupRuleAction) | |
object (GroupRuleConditions) | |
| name | string |
| status | string (GroupRuleStatus) Enum: "ACTIVE" "INACTIVE" "INVALID" |
| type | string |
{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "name": "string",
- "status": "ACTIVE",
- "type": "string"
}{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "string"
}Fetches a specific group rule by id from your organization
| ruleId required | string |
| expand | string |
{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "string"
}Updates a group rule. Only INACTIVE rules can be updated.
| ruleId required | string |
object (GroupRuleAction) | |
object (GroupRuleConditions) | |
| name | string |
| status | string (GroupRuleStatus) Enum: "ACTIVE" "INACTIVE" "INVALID" |
| type | string |
{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "name": "string",
- "status": "ACTIVE",
- "type": "string"
}{- "actions": {
- "assignUserToGroups": {
- "groupIds": [
- "string"
]
}
}, - "conditions": {
- "expression": {
- "type": "string",
- "value": "string"
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "string"
}Lists all group rules for your organization.
| groupId required | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "OKTA_GROUP"
}Updates the profile for a group with OKTA_GROUP type from your organization.
| groupId required | string |
object (GroupProfile) | |
| type | string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN" |
{- "profile": {
- "description": "string",
- "name": "string"
}, - "type": "OKTA_GROUP"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "OKTA_GROUP"
}Enumerates all applications that are assigned to a group.
| groupId required | string |
| after | string Specifies the pagination cursor for the next page of apps |
| limit | integer <int32> Default: 20 Specifies the number of app results for a page |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "accessibility": {
- "errorRedirectUrl": "string",
- "loginRedirectUrl": "string",
- "selfService": true
}, - "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "signing": {
- "kid": "string",
- "lastRotated": "2019-08-24T14:15:22Z",
- "nextRotation": "2019-08-24T14:15:22Z",
- "rotationMode": "string",
- "use": "sig"
}, - "userNameTemplate": {
- "suffix": "string",
- "template": "string",
- "type": "string"
}
}, - "features": [
- "string"
], - "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "licensing": {
- "seatCount": 0
}, - "name": "string",
- "profile": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "app": null,
- "implicitAssignment": true,
- "inlineHookId": "string",
- "notifications": {
- "vpn": {
- "helpUrl": "string",
- "message": "string",
- "network": {
- "connection": "string",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}
}
}, - "signOnMode": "BOOKMARK",
- "status": "ACTIVE",
- "visibility": {
- "appLinks": {
- "property1": true,
- "property2": true
}, - "autoSubmitToolbar": true,
- "hide": {
- "iOS": true,
- "web": true
}
}
}
]Success
| groupId required | string |
| expand | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "SUPER_ADMIN"
}
]Assigns a Role to a Group
| groupId required | string |
| disableNotifications | string |
| type | string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN" |
{- "type": "SUPER_ADMIN"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "SUPER_ADMIN"
}Success
| groupId required | string |
| roleId required | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "SUPER_ADMIN"
}Lists all App targets for an APP_ADMIN Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an ID value, while Application will not have an ID.
| groupId required | string |
| roleId required | string |
| after | string |
| limit | integer <int32> Default: 20 |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "category": "string",
- "description": "string",
- "displayName": "string",
- "features": [
- "string"
], - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "signOnModes": [
- "string"
], - "status": "ACTIVE",
- "verificationStatus": "string",
- "website": "string"
}
]Success
| groupId required | string |
| roleId required | string |
| after | string |
| limit | integer <int32> Default: 20 |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "OKTA_GROUP"
}
]Enumerates all users that are a member of a group.
| groupId required | string |
| after | string Specifies the pagination cursor for the next page of users |
| limit | integer <int32> Default: 1000 Specifies the number of user results in a page |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "activated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "id": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "status": "ACTIVE",
- "statusChanged": "2019-08-24T14:15:22Z",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}
}
]Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.
| q | string Searches the name property of IdPs for matching value |
| after | string Specifies the pagination cursor for the next page of IdPs |
| limit | integer <int32> Default: 20 Specifies the number of IdP results in a page |
| type | string Filters IdPs by type |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "NONE",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "USERNAME",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "OPAQUE"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "SAML2"
}, - "status": "ACTIVE",
- "type": "SAML2"
}
]Adds a new IdP to your organization.
| issuerMode | string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN" |
| name | string |
object (IdentityProviderPolicy) | |
object (Protocol) | |
| status | string Enum: "ACTIVE" "INACTIVE" |
| type | string Enum: "SAML2" "GOOGLE" "FACEBOOK" "LINKEDIN" "MICROSOFT" "OIDC" "OKTA" "IWA" "AgentlessDSSO" "X509" |
{- "issuerMode": "ORG_URL",
- "name": "string",
- "policy": {
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "NONE",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "USERNAME",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "OPAQUE"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "SAML2"
}, - "status": "ACTIVE",
- "type": "SAML2"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "NONE",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "USERNAME",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "OPAQUE"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "SAML2"
}, - "status": "ACTIVE",
- "type": "SAML2"
}Enumerates IdP key credentials.
| after | string Specifies the pagination cursor for the next page of keys |
| limit | integer <int32> Default: 20 Specifies the number of key results in a page |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}
]Adds a new X.509 certificate credential to the IdP key store.
| alg | string |
| created | string <date-time> |
| e | string |
| expiresAt | string <date-time> |
| key_ops | Array of strings |
| kid | string |
| kty | string |
| lastUpdated | string <date-time> |
| n | string |
| status | string |
| use | string |
| x5c | Array of strings |
| x5t | string |
| x5t#S256 | string |
| x5u | string |
{- "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Gets a specific IdP Key Credential by kid
| keyId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Fetches an IdP by id.
| idpId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "NONE",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "USERNAME",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "OPAQUE"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "SAML2"
}, - "status": "ACTIVE",
- "type": "SAML2"
}Updates the configuration for an IdP.
| idpId required | string |
| issuerMode | string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN" |
| name | string |
object (IdentityProviderPolicy) | |
object (Protocol) | |
| status | string Enum: "ACTIVE" "INACTIVE" |
| type | string Enum: "SAML2" "GOOGLE" "FACEBOOK" "LINKEDIN" "MICROSOFT" "OIDC" "OKTA" "IWA" "AgentlessDSSO" "X509" |
{- "issuerMode": "ORG_URL",
- "name": "string",
- "policy": {
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "NONE",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "USERNAME",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "OPAQUE"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "SAML2"
}, - "status": "ACTIVE",
- "type": "SAML2"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "NONE",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "USERNAME",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "OPAQUE"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "SAML2"
}, - "status": "ACTIVE",
- "type": "SAML2"
}Generates a new key pair and returns a Certificate Signing Request for it.
| idpId required | string |
object (CsrMetadataSubject) | |
object (CsrMetadataSubjectAltNames) |
{- "subject": {
- "commonName": "string",
- "countryName": "string",
- "localityName": "string",
- "organizationName": "string",
- "organizationalUnitName": "string",
- "stateOrProvinceName": "string"
}, - "subjectAltNames": {
- "dnsNames": [
- "string"
]
}
}{- "created": "2019-08-24T14:15:22Z",
- "csr": "string",
- "id": "string",
- "kty": "string"
}Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
| idpId required | string |
| csrId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Enumerates signing key credentials for an IdP
| idpId required | string |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}
]Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP
| idpId required | string |
| validityYears required | integer <int32> expiry of the IdP Key Credential |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Gets a specific IdP Key Credential by kid
| idpId required | string |
| keyId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP
| idpId required | string |
| keyId required | string |
| targetIdpId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}Activates an inactive IdP.
| idpId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "NONE",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "USERNAME",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "OPAQUE"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "SAML2"
}, - "status": "ACTIVE",
- "type": "SAML2"
}Deactivates an active IdP.
| idpId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "NONE",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "USERNAME",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "OPAQUE"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "SAML2"
}, - "status": "ACTIVE",
- "type": "SAML2"
}Find all the users linked to an identity provider
| idpId required | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "string",
- "externalId": "string",
- "id": "string",
- "lastUpdated": "string",
- "profile": {
- "property1": { },
- "property2": { }
}
}
]Fetches a linked IdP user by ID
| idpId required | string |
| userId required | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "string",
- "externalId": "string",
- "id": "string",
- "lastUpdated": "string",
- "profile": {
- "property1": { },
- "property2": { }
}
}Links an Okta user to an existing Social Identity Provider. This does not support the SAML2 Identity Provider Type
| idpId required | string |
| userId required | string |
| externalId | string |
{- "externalId": "string"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "string",
- "externalId": "string",
- "id": "string",
- "lastUpdated": "string",
- "profile": {
- "property1": { },
- "property2": { }
}
}Fetches the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.
| idpId required | string |
| userId required | string |
[- {
- "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "scopes": [
- "string"
], - "token": "string",
- "tokenAuthScheme": "string",
- "tokenType": "ACCESS"
}
][- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "string",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "method": "string",
- "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.oauth2.tokens.transform",
- "version": "string"
}
]Success
object (InlineHookChannel) | |
| name | string |
| status | string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE" |
| type | string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import" |
| version | string |
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "string",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "method": "string",
- "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.oauth2.tokens.transform",
- "version": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "string",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "method": "string",
- "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.oauth2.tokens.transform",
- "version": "string"
}Gets an inline hook by ID
| inlineHookId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "string",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "method": "string",
- "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.oauth2.tokens.transform",
- "version": "string"
}Updates an inline hook by ID
| inlineHookId required | string |
object (InlineHookChannel) | |
| name | string |
| status | string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE" |
| type | string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import" |
| version | string |
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "string",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "method": "string",
- "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.oauth2.tokens.transform",
- "version": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "string",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "method": "string",
- "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.oauth2.tokens.transform",
- "version": "string"
}Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.
| inlineHookId required | string |
{ }{- "commands": [
- {
- "type": "string",
- "value": [
- {
- "op": "string",
- "path": "string",
- "value": "string"
}
]
}
]
}Activates the Inline Hook matching the provided id
| inlineHookId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "string",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "method": "string",
- "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.oauth2.tokens.transform",
- "version": "string"
}Deactivates the Inline Hook matching the provided id
| inlineHookId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "string",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "method": "string",
- "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.oauth2.tokens.transform",
- "version": "string"
}The Okta System Log API provides read access to your organization’s system log. This API provides more functionality than the Events API
| since | string <date-time> |
| until | string <date-time> |
| filter | string |
| q | string |
| limit | integer Default: 100 |
| sortOrder | string Default: "ASCENDING" |
| after | string |
[- {
- "actor": {
- "alternateId": "string",
- "detail": {
- "property1": { },
- "property2": { }
}, - "displayName": "string",
- "id": "string",
- "type": "string"
}, - "authenticationContext": {
- "authenticationProvider": "OKTA_AUTHENTICATION_PROVIDER",
- "authenticationStep": 0,
- "credentialProvider": "OKTA_AUTHENTICATION_PROVIDER",
- "credentialType": "OTP",
- "externalSessionId": "string",
- "interface": "string",
- "issuer": {
- "id": "string",
- "type": "string"
}
}, - "client": {
- "device": "string",
- "geographicalContext": {
- "city": "string",
- "country": "string",
- "geolocation": {
- "lat": 0,
- "lon": 0
}, - "postalCode": "string",
- "state": "string"
}, - "id": "string",
- "ipAddress": "string",
- "userAgent": {
- "browser": "string",
- "os": "string",
- "rawUserAgent": "string"
}, - "zone": "string"
}, - "debugContext": {
- "debugData": {
- "property1": { },
- "property2": { }
}
}, - "displayMessage": "string",
- "eventType": "string",
- "legacyEventType": "string",
- "outcome": {
- "reason": "string",
- "result": "string"
}, - "published": "2019-08-24T14:15:22Z",
- "request": {
- "ipChain": [
- {
- "geographicalContext": {
- "city": "string",
- "country": "string",
- "geolocation": {
- "lat": 0,
- "lon": 0
}, - "postalCode": "string",
- "state": "string"
}, - "ip": "string",
- "source": "string",
- "version": "string"
}
]
}, - "securityContext": {
- "asNumber": 0,
- "asOrg": "string",
- "domain": "string",
- "isProxy": true,
- "isp": "string"
}, - "severity": "DEBUG",
- "target": [
- {
- "alternateId": "string",
- "detailEntry": {
- "property1": { },
- "property2": { }
}, - "displayName": "string",
- "id": "string",
- "type": "string"
}
], - "transaction": {
- "detail": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "type": "string"
}, - "uuid": "string",
- "version": "string"
}
]Enumerates Profile Mappings in your organization with pagination.
| after | string |
| limit | integer <int32> Default: -1 |
| sourceId | string |
| targetId | string Default: "" |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "properties": {
- "property1": {
- "expression": "string",
- "pushStatus": "PUSH"
}, - "property2": {
- "expression": "string",
- "pushStatus": "PUSH"
}
}, - "source": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "name": "string",
- "type": "string"
}, - "target": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "name": "string",
- "type": "string"
}
}
]Fetches a single Profile Mapping referenced by its ID.
| mappingId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "properties": {
- "property1": {
- "expression": "string",
- "pushStatus": "PUSH"
}, - "property2": {
- "expression": "string",
- "pushStatus": "PUSH"
}
}, - "source": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "name": "string",
- "type": "string"
}, - "target": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "name": "string",
- "type": "string"
}
}Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings.
| mappingId required | string |
object (ProfileMappingSource) | |
object (ProfileMappingSource) |
{- "source": { },
- "target": { }
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "properties": {
- "property1": {
- "expression": "string",
- "pushStatus": "PUSH"
}, - "property2": {
- "expression": "string",
- "pushStatus": "PUSH"
}
}, - "source": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "name": "string",
- "type": "string"
}, - "target": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "id": "string",
- "name": "string",
- "type": "string"
}
}Fetches the Schema for an App User
| appInstanceId required | string |
{- "$schema": "string",
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "string",
- "definitions": {
- "base": {
- "id": "string",
- "properties": {
- "city": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "costCenter": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "countryCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "department": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "displayName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "division": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "email": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "employeeNumber": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "firstName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificPrefix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificSuffix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "lastName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "locale": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "login": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "manager": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "managerId": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "middleName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "mobilePhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "nickName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "organization": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "postalAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "preferredLanguage": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "primaryPhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "profileUrl": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "secondEmail": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "state": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "streetAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "timezone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "title": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "userType": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "zipCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}
}, - "required": [
- "string"
], - "type": "string"
}, - "custom": {
- "id": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "required": [
- "string"
], - "type": "string"
}
}, - "id": "string",
- "lastUpdated": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "title": "string",
- "type": "string"
}Partial updates on the User Profile properties of the Application User Schema.
| appInstanceId required | string |
object (UserSchemaDefinitions) | |
| title | string |
{- "definitions": {
- "base": {
- "properties": {
- "city": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "costCenter": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "countryCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "department": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "displayName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "division": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "email": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "employeeNumber": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "firstName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificPrefix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificSuffix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "lastName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "locale": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "login": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "manager": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "managerId": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "middleName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "mobilePhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "nickName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "organization": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "postalAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "preferredLanguage": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "primaryPhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "profileUrl": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "secondEmail": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "state": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "streetAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "timezone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "title": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "userType": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "zipCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}
}, - "required": [
- "string"
], - "type": "string"
}, - "custom": {
- "properties": {
- "property1": { },
- "property2": { }
}, - "required": [
- "string"
], - "type": "string"
}
}, - "title": "string"
}{- "$schema": "string",
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "string",
- "definitions": {
- "base": {
- "id": "string",
- "properties": {
- "city": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "costCenter": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "countryCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "department": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "displayName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "division": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "email": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "employeeNumber": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "firstName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificPrefix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificSuffix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "lastName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "locale": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "login": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "manager": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "managerId": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "middleName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "mobilePhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "nickName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "organization": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "postalAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "preferredLanguage": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "primaryPhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "profileUrl": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "secondEmail": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "state": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "streetAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "timezone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "title": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "userType": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "zipCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}
}, - "required": [
- "string"
], - "type": "string"
}, - "custom": {
- "id": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "required": [
- "string"
], - "type": "string"
}
}, - "id": "string",
- "lastUpdated": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "title": "string",
- "type": "string"
}Fetches the schema for a Schema Id.
| schemaId required | string |
{- "$schema": "string",
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "string",
- "definitions": {
- "base": {
- "id": "string",
- "properties": {
- "city": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "costCenter": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "countryCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "department": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "displayName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "division": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "email": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "employeeNumber": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "firstName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificPrefix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificSuffix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "lastName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "locale": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "login": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "manager": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "managerId": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "middleName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "mobilePhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "nickName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "organization": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "postalAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "preferredLanguage": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "primaryPhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "profileUrl": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "secondEmail": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "state": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "streetAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "timezone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "title": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "userType": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "zipCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}
}, - "required": [
- "string"
], - "type": "string"
}, - "custom": {
- "id": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "required": [
- "string"
], - "type": "string"
}
}, - "id": "string",
- "lastUpdated": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "title": "string",
- "type": "string"
}Partial updates on the User Profile properties of the user schema.
| schemaId required | string |
object (UserSchemaDefinitions) | |
| title | string |
{- "definitions": {
- "base": {
- "properties": {
- "city": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "costCenter": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "countryCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "department": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "displayName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "division": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "email": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "employeeNumber": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "firstName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificPrefix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificSuffix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "lastName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "locale": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "login": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "manager": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "managerId": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "middleName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "mobilePhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "nickName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "organization": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "postalAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "preferredLanguage": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "primaryPhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "profileUrl": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "secondEmail": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "state": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "streetAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "timezone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "title": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "userType": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "zipCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}
}, - "required": [
- "string"
], - "type": "string"
}, - "custom": {
- "properties": {
- "property1": { },
- "property2": { }
}, - "required": [
- "string"
], - "type": "string"
}
}, - "title": "string"
}{- "$schema": "string",
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "string",
- "definitions": {
- "base": {
- "id": "string",
- "properties": {
- "city": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "costCenter": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "countryCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "department": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "displayName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "division": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "email": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "employeeNumber": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "firstName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificPrefix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "honorificSuffix": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "lastName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "locale": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "login": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "manager": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "managerId": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "middleName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "mobilePhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "nickName": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "organization": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "postalAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "preferredLanguage": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "primaryPhone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "profileUrl": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "secondEmail": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "state": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "streetAddress": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "timezone": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "title": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "userType": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}, - "zipCode": {
- "description": "string",
- "master": {
- "type": "string"
}, - "maxLength": 0,
- "minLength": 0,
- "mutability": "string",
- "permissions": [
- {
- "action": "string",
- "principal": "string"
}
], - "required": true,
- "scope": "string",
- "title": "string",
- "type": "string"
}
}, - "required": [
- "string"
], - "type": "string"
}, - "custom": {
- "id": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "required": [
- "string"
], - "type": "string"
}
}, - "id": "string",
- "lastUpdated": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "title": "string",
- "type": "string"
}[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "associated": {
- "description": "string",
- "name": "string",
- "title": "string",
- "type": "USER"
}, - "primary": {
- "description": "string",
- "name": "string",
- "title": "string",
- "type": "USER"
}
}
]Success
object (LinkedObjectDetails) | |
object (LinkedObjectDetails) |
{- "associated": {
- "description": "string",
- "name": "string",
- "title": "string",
- "type": "USER"
}, - "primary": {
- "description": "string",
- "name": "string",
- "title": "string",
- "type": "USER"
}
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "associated": {
- "description": "string",
- "name": "string",
- "title": "string",
- "type": "USER"
}, - "primary": {
- "description": "string",
- "name": "string",
- "title": "string",
- "type": "USER"
}
}Success
| linkedObjectName required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "associated": {
- "description": "string",
- "name": "string",
- "title": "string",
- "type": "USER"
}, - "primary": {
- "description": "string",
- "name": "string",
- "title": "string",
- "type": "USER"
}
}[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}
]Creates a new User Type. A default User Type is automatically created along with your org, and you may add another 9 User Types for a maximum of 10.
| description | string |
| displayName | string |
| id | string |
| name | string |
{- "description": "string",
- "displayName": "string",
- "id": "string",
- "name": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}Fetches a User Type by ID. The special identifier default may be used to fetch the default User Type.
| typeId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}Updates an existing User Type
| typeId required | string |
| description | string |
| displayName | string |
| id | string |
| name | string |
{- "description": "string",
- "displayName": "string",
- "id": "string",
- "name": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}Replace an existing User Type
| typeId required | string |
| description | string |
| displayName | string |
| id | string |
| name | string |
{- "description": "string",
- "displayName": "string",
- "id": "string",
- "name": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}Gets all policies with the specified type.
| type required | string |
| status | string |
| expand | string Default: "" |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}
]Creates a policy.
| activate | boolean Default: true |
object (PolicyRuleConditions) | |
| description | string |
| name | string |
| priority | integer |
| status | string Enum: "ACTIVE" "INACTIVE" |
| system | boolean |
| type | string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY" |
{- "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "description": "string",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}Gets a policy.
| policyId required | string |
| expand | string Default: "" |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}Updates a policy.
| policyId required | string |
object (PolicyRuleConditions) | |
| description | string |
| name | string |
| priority | integer |
| status | string Enum: "ACTIVE" "INACTIVE" |
| system | boolean |
| type | string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY" |
{- "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "description": "string",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "OAUTH_AUTHORIZATION_POLICY"
}Enumerates all policy rules.
| policyId required | string |
[- {
- "actions": {
- "enroll": {
- "self": "CHALLENGE"
}, - "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW"
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}, - "signon": {
- "access": "ALLOW",
- "factorLifetime": 0,
- "factorPromptMode": "ALWAYS",
- "rememberDeviceByDefault": false,
- "requireFactor": false,
- "session": {
- "maxSessionIdleMinutes": 120,
- "maxSessionLifetimeMinutes": 0,
- "usePersistentCookie": false
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "SIGN_ON"
}
]Creates a policy rule.
| policyId required | string |
object (PolicyRuleActions) | |
object (PolicyRuleConditions) | |
| name | string |
| priority | integer |
| status | string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE" |
| system | boolean Default: false |
| type | string Enum: "SIGN_ON" "PASSWORD" |
{- "actions": {
- "enroll": {
- "self": "CHALLENGE"
}, - "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW"
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}, - "signon": {
- "access": "ALLOW",
- "factorLifetime": 0,
- "factorPromptMode": "ALWAYS",
- "rememberDeviceByDefault": false,
- "requireFactor": false,
- "session": {
- "maxSessionIdleMinutes": 120,
- "maxSessionLifetimeMinutes": 0,
- "usePersistentCookie": false
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "SIGN_ON"
}{- "actions": {
- "enroll": {
- "self": "CHALLENGE"
}, - "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW"
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}, - "signon": {
- "access": "ALLOW",
- "factorLifetime": 0,
- "factorPromptMode": "ALWAYS",
- "rememberDeviceByDefault": false,
- "requireFactor": false,
- "session": {
- "maxSessionIdleMinutes": 120,
- "maxSessionLifetimeMinutes": 0,
- "usePersistentCookie": false
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "SIGN_ON"
}Gets a policy rule.
| policyId required | string |
| ruleId required | string |
{- "actions": {
- "enroll": {
- "self": "CHALLENGE"
}, - "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW"
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}, - "signon": {
- "access": "ALLOW",
- "factorLifetime": 0,
- "factorPromptMode": "ALWAYS",
- "rememberDeviceByDefault": false,
- "requireFactor": false,
- "session": {
- "maxSessionIdleMinutes": 120,
- "maxSessionLifetimeMinutes": 0,
- "usePersistentCookie": false
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "SIGN_ON"
}Updates a policy rule.
| policyId required | string |
| ruleId required | string |
object (PolicyRuleActions) | |
object (PolicyRuleConditions) | |
| name | string |
| priority | integer |
| status | string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE" |
| system | boolean Default: false |
| type | string Enum: "SIGN_ON" "PASSWORD" |
{- "actions": {
- "enroll": {
- "self": "CHALLENGE"
}, - "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW"
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}, - "signon": {
- "access": "ALLOW",
- "factorLifetime": 0,
- "factorPromptMode": "ALWAYS",
- "rememberDeviceByDefault": false,
- "requireFactor": false,
- "session": {
- "maxSessionIdleMinutes": 120,
- "maxSessionLifetimeMinutes": 0,
- "usePersistentCookie": false
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "SIGN_ON"
}{- "actions": {
- "enroll": {
- "self": "CHALLENGE"
}, - "passwordChange": {
- "access": "ALLOW"
}, - "selfServicePasswordReset": {
- "access": "ALLOW"
}, - "selfServiceUnlock": {
- "access": "ALLOW"
}, - "signon": {
- "access": "ALLOW",
- "factorLifetime": 0,
- "factorPromptMode": "ALWAYS",
- "rememberDeviceByDefault": false,
- "requireFactor": false,
- "session": {
- "maxSessionIdleMinutes": 120,
- "maxSessionLifetimeMinutes": 0,
- "usePersistentCookie": false
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP_TYPE"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVE"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "IOS"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "OMM"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": "EXPRESSION",
- "value": "string"
}
}, - "type": "DESKTOP"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "SUFFIX",
- "value": "string"
}
], - "type": "IDENTIFIER"
}, - "userStatus": {
- "value": "ACTIVE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": false,
- "type": "SIGN_ON"
}Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL.
| sessionToken | string |
{- "sessionToken": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "amr": [
- "pwd"
], - "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "idp": {
- "id": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "lastFactorVerification": "2019-08-24T14:15:22Z",
- "lastPasswordVerification": "2019-08-24T14:15:22Z",
- "login": "string",
- "status": "ACTIVE",
- "userId": "string"
}Get details about a session.
| sessionId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "amr": [
- "pwd"
], - "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "idp": {
- "id": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "lastFactorVerification": "2019-08-24T14:15:22Z",
- "lastPasswordVerification": "2019-08-24T14:15:22Z",
- "login": "string",
- "status": "ACTIVE",
- "userId": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "amr": [
- "pwd"
], - "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "idp": {
- "id": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "lastFactorVerification": "2019-08-24T14:15:22Z",
- "lastPasswordVerification": "2019-08-24T14:15:22Z",
- "login": "string",
- "status": "ACTIVE",
- "userId": "string"
}Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type.
| templateType | string |
[- {
- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}
]Adds a new custom SMS template to your organization.
| name | string |
| template | string |
| translations | object (SmsTemplateTranslations) |
| type | string (SmsTemplateType) Value: "SMS_VERIFY_CODE" |
{- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}Fetches a specific template by id
| templateId required | string |
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}Updates only some of the SMS template properties:
| templateId required | string |
| name | string |
| template | string |
| translations | object (SmsTemplateTranslations) |
| type | string (SmsTemplateType) Value: "SMS_VERIFY_CODE" |
{- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}Updates the SMS template.
| templateId required | string |
| name | string |
| template | string |
| translations | object (SmsTemplateTranslations) |
| type | string (SmsTemplateType) Value: "SMS_VERIFY_CODE" |
{- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "action": "string",
- "created": "2019-08-24T14:15:22Z",
- "excludeZones": [
- "string"
], - "lastUpdated": "2019-08-24T14:15:22Z"
}Updates ThreatInsight configuration
| action | string |
| excludeZones | Array of strings |
{- "action": "string",
- "excludeZones": [
- "string"
]
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "action": "string",
- "created": "2019-08-24T14:15:22Z",
- "excludeZones": [
- "string"
], - "lastUpdated": "2019-08-24T14:15:22Z"
}Success
| q | string |
| filter | string |
| after | string |
| limit | integer <int32> Default: -1 |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string",
- "origin": "string",
- "scopes": [
- {
- "stringValue": "string",
- "type": "CORS"
}
], - "status": "string"
}
]Success
| createdBy | string |
| lastUpdatedBy | string |
| name | string |
| origin | string |
Array of objects (Scope) | |
| status | string |
{- "createdBy": "string",
- "lastUpdatedBy": "string",
- "name": "string",
- "origin": "string",
- "scopes": [
- {
- "stringValue": "string",
- "type": "CORS"
}
], - "status": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string",
- "origin": "string",
- "scopes": [
- {
- "stringValue": "string",
- "type": "CORS"
}
], - "status": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string",
- "origin": "string",
- "scopes": [
- {
- "stringValue": "string",
- "type": "CORS"
}
], - "status": "string"
}Success
| trustedOriginId required | string |
| createdBy | string |
| lastUpdatedBy | string |
| name | string |
| origin | string |
Array of objects (Scope) | |
| status | string |
{- "createdBy": "string",
- "lastUpdatedBy": "string",
- "name": "string",
- "origin": "string",
- "scopes": [
- {
- "stringValue": "string",
- "type": "CORS"
}
], - "status": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string",
- "origin": "string",
- "scopes": [
- {
- "stringValue": "string",
- "type": "CORS"
}
], - "status": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string",
- "origin": "string",
- "scopes": [
- {
- "stringValue": "string",
- "type": "CORS"
}
], - "status": "string"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string",
- "origin": "string",
- "scopes": [
- {
- "stringValue": "string",
- "type": "CORS"
}
], - "status": "string"
}Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.
| q | string Finds a user that matches firstName, lastName, and email properties |
| after | string Specifies the pagination cursor for the next page of users |
| limit | integer <int32> Default: 10 Specifies the number of results returned |
| filter | string Filters users with a supported expression for a subset of properties |
| search | string Searches for users with a supported filtering expression for most properties |
| sortBy | string |
| sortOrder | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "activated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "id": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "status": "ACTIVE",
- "statusChanged": "2019-08-24T14:15:22Z",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}
}
]Creates a new user in your Okta organization with or without credentials.
| activate | boolean Default: true Executes activation lifecycle operation when creating the user |
| provider | boolean Default: false Indicates whether to create a user with a specified authentication provider |
| nextLogin | string Default: "" With activate=true, set nextLogin to "changePassword" to have the password be EXPIRED, so user must change it the next time they log in. |
object (UserCredentials) | |
| groupIds | Array of strings |
object (UserProfile) | |
object (UserType) |
{- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "groupIds": [
- "string"
], - "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "type": {
- "description": "string",
- "displayName": "string",
- "id": "string",
- "name": "string"
}
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "activated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "id": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "status": "ACTIVE",
- "statusChanged": "2019-08-24T14:15:22Z",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}
}Fetches a user from your Okta organization.
| userId required | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "activated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "id": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "status": "ACTIVE",
- "statusChanged": "2019-08-24T14:15:22Z",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}
}Fetch a user by id, login, or login shortname if the short name is unambiguous.
| userId required | string |
| strict | boolean |
object (UserCredentials) | |
object (UserProfile) | |
| status | string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED" |
| transitioningToStatus | string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED" |
object (UserType) |
{- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "status": "ACTIVE",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "description": "string",
- "displayName": "string",
- "id": "string",
- "name": "string"
}
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "activated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "id": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "status": "ACTIVE",
- "statusChanged": "2019-08-24T14:15:22Z",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}
}Update a user's profile and/or credentials using strict-update semantics.
| userId required | string |
| strict | boolean |
object (UserCredentials) | |
object (UserProfile) | |
| status | string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED" |
| transitioningToStatus | string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED" |
object (UserType) |
{- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "status": "ACTIVE",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "description": "string",
- "displayName": "string",
- "id": "string",
- "name": "string"
}
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "activated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "id": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "status": "ACTIVE",
- "statusChanged": "2019-08-24T14:15:22Z",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}
}Fetches appLinks for all direct or indirect (via group membership) assigned applications.
| userId required | string |
[- {
- "appAssignmentId": "string",
- "appInstanceId": "string",
- "appName": "string",
- "credentialsSetup": true,
- "hidden": true,
- "id": "string",
- "label": "string",
- "linkUrl": "string",
- "logoUrl": "string",
- "sortOrder": 0
}
]Lists all client resources for which the specified user has grants or tokens.
| userId required | string |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "client_id": "string",
- "client_name": "string",
- "client_uri": "string",
- "logo_uri": "string"
}
]Lists all grants for a specified user and client
| userId required | string |
| clientId required | string |
| expand | string |
| after | string |
| limit | integer <int32> Default: 20 |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopeId": "string",
- "source": "END_USER",
- "status": "ACTIVE",
- "userId": "string"
}
]Lists all refresh tokens issued for the specified User and Client.
| userId required | string |
| clientId required | string |
| expand | string |
| after | string |
| limit | integer <int32> Default: 20 |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopes": [
- "string"
], - "status": "ACTIVE",
- "userId": "string"
}
]Gets a refresh token issued for the specified User and Client.
| userId required | string |
| clientId required | string |
| tokenId required | string |
| expand | string |
| limit | integer Default: 20 |
| after | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "expiresAt": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopes": [
- "string"
], - "status": "ACTIVE",
- "userId": "string"
}Changes a user's password by validating the user's current password. This operation can only be performed on users in STAGED, ACTIVE, PASSWORD_EXPIRED, or RECOVERY status that have a valid password credential
| userId required | string |
| strict | boolean |
object (PasswordCredential) | |
object (PasswordCredential) |
{- "newPassword": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "oldPassword": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}
}{- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}Changes a user's recovery question & answer credential by validating the user's current password. This operation can only be performed on users in STAGED, ACTIVE or RECOVERY status that have a valid password credential
| userId required | string |
object (PasswordCredential) | |
object (AuthenticationProvider) | |
object (RecoveryQuestionCredential) |
{- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}{- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}{- "resetPasswordUrl": "string"
}Lists all grants for the specified user
| userId required | string |
| scopeId | string |
| expand | string |
| after | string |
| limit | integer <int32> Default: 20 |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopeId": "string",
- "source": "END_USER",
- "status": "ACTIVE",
- "userId": "string"
}
]Gets a grant for the specified user
| userId required | string |
| grantId required | string |
| expand | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "clientId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "id": "string",
- "type": "string"
}, - "id": "string",
- "issuer": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "scopeId": "string",
- "source": "END_USER",
- "status": "ACTIVE",
- "userId": "string"
}Fetches the groups of which the user is a member.
| userId required | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "OKTA_GROUP"
}
]Lists the IdPs associated with the user.
| userId required | string |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "ORG_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "NONE",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "USERNAME",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "RESPONSE"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "OPAQUE"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "SAML2"
}, - "status": "ACTIVE",
- "type": "SAML2"
}
]Activates a user. This operation can only be performed on users with a STAGED status. Activation of a user is an asynchronous operation. The user will have the transitioningToStatus property with a value of ACTIVE during activation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of ACTIVE when the activation process is complete.
| userId required | string |
| sendEmail required | boolean Default: true Sends an activation email to the user if true |
{- "activationToken": "string",
- "activationUrl": "string"
}Deactivates a user. This operation can only be performed on users that do not have a DEPROVISIONED status. Deactivation of a user is an asynchronous operation. The user will have the transitioningToStatus property with a value of DEPROVISIONED during deactivation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of DEPROVISIONED when the deactivation process is complete.
| userId required | string |
| sendEmail | boolean Default: false |
This operation transitions the user to the status of PASSWORD_EXPIRED so that the user is required to change their password at their next login.
| userId required | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "activated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "credentials": {
- "password": {
- "hash": {
- "algorithm": "BCRYPT",
- "salt": "string",
- "saltOrder": "string",
- "value": "string",
- "workFactor": 0
}, - "hook": {
- "type": "string"
}, - "value": "pa$$word"
}, - "provider": {
- "name": "string",
- "type": "ACTIVE_DIRECTORY"
}, - "recovery_question": {
- "answer": "string",
- "question": "string"
}
}, - "id": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "passwordChanged": "2019-08-24T14:15:22Z",
- "profile": {
- "city": "string",
- "costCenter": "string",
- "countryCode": "string",
- "department": "string",
- "displayName": "string",
- "division": "string",
- "email": "string",
- "employeeNumber": "string",
- "firstName": "string",
- "honorificPrefix": "string",
- "honorificSuffix": "string",
- "lastName": "string",
- "locale": "string",
- "login": "string",
- "manager": "string",
- "managerId": "string",
- "middleName": "string",
- "mobilePhone": "string",
- "nickName": "string",
- "organization": "string",
- "postalAddress": "string",
- "preferredLanguage": "string",
- "primaryPhone": "string",
- "profileUrl": "string",
- "secondEmail": "string",
- "state": "string",
- "streetAddress": "string",
- "timezone": "string",
- "title": "string",
- "userType": "string",
- "zipCode": "string"
}, - "status": "ACTIVE",
- "statusChanged": "2019-08-24T14:15:22Z",
- "transitioningToStatus": "ACTIVE",
- "type": {
- "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "default": true,
- "description": "string",
- "displayName": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "name": "string"
}
}Reactivates a user. This operation can only be performed on users with a PROVISIONED status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from Activate User.
| userId required | string |
| sendEmail | boolean Default: false Sends an activation email to the user if true |
{- "activationToken": "string",
- "activationUrl": "string"
}This operation resets all factors for the specified user. All MFA factor enrollments returned to the unenrolled state. The user's status remains ACTIVE. This link is present only if the user is currently enrolled in one or more MFA factors.
| userId required | string |
Generates a one-time token (OTT) that can be used to reset a user's password. The OTT link can be automatically emailed to the user or returned to the API caller and distributed using a custom flow.
| userId required | string |
| sendEmail required | boolean |
{- "resetPasswordUrl": "string"
}Get linked objects for a user, relationshipName can be a primary or associated relationship name
| userId required | string |
| relationshipName required | string |
| after | string |
| limit | integer <int32> Default: -1 |
[- { }
]Lists all roles assigned to a user.
| userId required | string |
| expand | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "SUPER_ADMIN"
}
]Assigns a role to a user.
| userId required | string |
| disableNotifications | string |
| type | string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN" |
{- "type": "SUPER_ADMIN"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "assignmentType": "GROUP",
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "label": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "status": "ACTIVE",
- "type": "SUPER_ADMIN"
}Lists all App targets for an APP_ADMIN Role assigned to a User. This methods return list may include full Applications or Instances. The response for an instance will have an ID value, while Application will not have an ID.
| userId required | string |
| roleId required | string |
| after | string |
| limit | integer <int32> Default: 20 |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "category": "string",
- "description": "string",
- "displayName": "string",
- "features": [
- "string"
], - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "signOnModes": [
- "string"
], - "status": "ACTIVE",
- "verificationStatus": "string",
- "website": "string"
}
]Success
| userId required | string |
| roleId required | string |
| after | string |
| limit | integer <int32> Default: 20 |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastMembershipUpdated": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "objectClass": [
- "string"
], - "profile": {
- "description": "string",
- "name": "string"
}, - "type": "OKTA_GROUP"
}
]Removes all active identity provider sessions. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.
| userId required | string |
| oauthTokens | boolean Default: false Revoke issued OpenID Connect and OAuth refresh and access tokens |
Enumerates all the enrolled factors for the specified user
| userId required | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "factorType": "call",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "provider": "OKTA",
- "status": "PENDING_ACTIVATION",
- "verify": {
- "activationToken": "string",
- "answer": "string",
- "attestation": "string",
- "clientData": "string",
- "nextPassCode": "string",
- "passCode": "string",
- "registrationData": "string",
- "stateToken": "string"
}
}
]Enrolls a user with a supported factor.
| userId required | string |
| updatePhone | boolean Default: false |
| templateId | string id of SMS template (only for SMS factor) |
| tokenLifetimeSeconds | integer <int32> Default: 300 |
| activate | boolean Default: false |
Factor
| factorType | string (FactorType) Enum: "call" "email" "hotp" "push" "question" "sms" "token:hardware" "token:hotp" "token:software:totp" "token" "u2f" "web" "webauthn" |
| provider | string (FactorProvider) Enum: "OKTA" "RSA" "FIDO" "GOOGLE" "SYMANTEC" "DUO" "YUBICO" "CUSTOM" |
| status | string (FactorStatus) Enum: "PENDING_ACTIVATION" "ACTIVE" "INACTIVE" "NOT_SETUP" "ENROLLED" "DISABLED" "EXPIRED" |
object (VerifyFactorRequest) |
{- "factorType": "call",
- "provider": "OKTA",
- "status": "PENDING_ACTIVATION",
- "verify": {
- "activationToken": "string",
- "answer": "string",
- "attestation": "string",
- "clientData": "string",
- "nextPassCode": "string",
- "passCode": "string",
- "registrationData": "string",
- "stateToken": "string"
}
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "factorType": "call",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "provider": "OKTA",
- "status": "PENDING_ACTIVATION",
- "verify": {
- "activationToken": "string",
- "answer": "string",
- "attestation": "string",
- "clientData": "string",
- "nextPassCode": "string",
- "passCode": "string",
- "registrationData": "string",
- "stateToken": "string"
}
}Enumerates all the supported factors that can be enrolled for the specified user
| userId required | string |
[- {
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "factorType": "call",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "provider": "OKTA",
- "status": "PENDING_ACTIVATION",
- "verify": {
- "activationToken": "string",
- "answer": "string",
- "attestation": "string",
- "clientData": "string",
- "nextPassCode": "string",
- "passCode": "string",
- "registrationData": "string",
- "stateToken": "string"
}
}
]Fetches a factor for the specified user
| userId required | string |
| factorId required | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "factorType": "call",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "provider": "OKTA",
- "status": "PENDING_ACTIVATION",
- "verify": {
- "activationToken": "string",
- "answer": "string",
- "attestation": "string",
- "clientData": "string",
- "nextPassCode": "string",
- "passCode": "string",
- "registrationData": "string",
- "stateToken": "string"
}
}The sms and token:software:totp factor types require activation to complete the enrollment process.
| userId required | string |
| factorId required | string |
| attestation | string |
| clientData | string |
| passCode | string |
| registrationData | string |
| stateToken | string |
{- "attestation": "string",
- "clientData": "string",
- "passCode": "string",
- "registrationData": "string",
- "stateToken": "string"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "created": "2019-08-24T14:15:22Z",
- "factorType": "call",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "provider": "OKTA",
- "status": "PENDING_ACTIVATION",
- "verify": {
- "activationToken": "string",
- "answer": "string",
- "attestation": "string",
- "clientData": "string",
- "nextPassCode": "string",
- "passCode": "string",
- "registrationData": "string",
- "stateToken": "string"
}
}Polls factors verification transaction for status.
| userId required | string |
| factorId required | string |
| transactionId required | string |
{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "expiresAt": "2019-08-24T14:15:22Z",
- "factorResult": "SUCCESS",
- "factorResultMessage": "string"
}Verifies an OTP for a token or token:hardware factor
| userId required | string |
| factorId required | string |
| templateId | string |
| tokenLifetimeSeconds | integer <int32> Default: 300 |
| X-Forwarded-For | string |
| User-Agent | string |
| Accept-Language | string |
| activationToken | string |
| answer | string |
| attestation | string |
| clientData | string |
| nextPassCode | string |
| passCode | string |
| registrationData | string |
| stateToken | string |
{- "activationToken": "string",
- "answer": "string",
- "attestation": "string",
- "clientData": "string",
- "nextPassCode": "string",
- "passCode": "string",
- "registrationData": "string",
- "stateToken": "string"
}{- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "property1": { },
- "property2": { }
}, - "expiresAt": "2019-08-24T14:15:22Z",
- "factorResult": "SUCCESS",
- "factorResultMessage": "string"
}Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.
| after | string Specifies the pagination cursor for the next page of network zones |
| limit | integer <int32> Default: -1 Specifies the number of results for a page |
| filter | string Filters zones by usage or id expression |
[- {
- "_links": {
- "property1": { },
- "property2": { }
}, - "asns": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "gateways": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "locations": [
- {
- "country": "string",
- "region": "string"
}
], - "name": "string",
- "proxies": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "proxyType": "string",
- "status": "ACTIVE",
- "system": true,
- "type": "IP",
- "usage": "POLICY"
}
]Adds a new network zone to your Okta organization.
| asns | Array of strings |
Array of objects (NetworkZoneAddress) | |
Array of objects (NetworkZoneLocation) | |
| name | string |
Array of objects (NetworkZoneAddress) | |
| proxyType | string |
| status | string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE" |
| system | boolean |
| type | string (NetworkZoneType) Enum: "IP" "DYNAMIC" |
| usage | string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST" |
{- "asns": [
- "string"
], - "gateways": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "locations": [
- {
- "country": "string",
- "region": "string"
}
], - "name": "string",
- "proxies": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "proxyType": "string",
- "status": "ACTIVE",
- "system": true,
- "type": "IP",
- "usage": "POLICY"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "asns": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "gateways": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "locations": [
- {
- "country": "string",
- "region": "string"
}
], - "name": "string",
- "proxies": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "proxyType": "string",
- "status": "ACTIVE",
- "system": true,
- "type": "IP",
- "usage": "POLICY"
}Fetches a network zone from your Okta organization by id.
| zoneId required | string |
{- "_links": {
- "property1": { },
- "property2": { }
}, - "asns": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "gateways": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "locations": [
- {
- "country": "string",
- "region": "string"
}
], - "name": "string",
- "proxies": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "proxyType": "string",
- "status": "ACTIVE",
- "system": true,
- "type": "IP",
- "usage": "POLICY"
}Updates a network zone in your organization.
| zoneId required | string |
| asns | Array of strings |
Array of objects (NetworkZoneAddress) | |
Array of objects (NetworkZoneLocation) | |
| name | string |
Array of objects (NetworkZoneAddress) | |
| proxyType | string |
| status | string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE" |
| system | boolean |
| type | string (NetworkZoneType) Enum: "IP" "DYNAMIC" |
| usage | string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST" |
{- "asns": [
- "string"
], - "gateways": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "locations": [
- {
- "country": "string",
- "region": "string"
}
], - "name": "string",
- "proxies": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "proxyType": "string",
- "status": "ACTIVE",
- "system": true,
- "type": "IP",
- "usage": "POLICY"
}{- "_links": {
- "property1": { },
- "property2": { }
}, - "asns": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "gateways": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "locations": [
- {
- "country": "string",
- "region": "string"
}
], - "name": "string",
- "proxies": [
- {
- "type": "CIDR",
- "value": "string"
}
], - "proxyType": "string",
- "status": "ACTIVE",
- "system": true,
- "type": "IP",
- "usage": "POLICY"
}